Manages the materials available in the component. More...
Public Member Functions | |
| virtual | ~MaterialManager () |
| Material * | createOrRetrieve (nkMemory::StringView name, MATERIAL_TYPE type) |
| Material * | record (nkMemory::StringView name, nkMemory::UniquePtr< Material > resource) |
| Material * | get (nkMemory::StringView name) |
| Material * | getByIndex (unsigned int id) |
| void | rename (nkMemory::StringView currentName, nkMemory::StringView newName) |
| void | erase (nkMemory::StringView name) |
| nkMemory::UniquePtr< Material > | relinquish (nkMemory::StringView name) |
Manages the materials available in the component.
At all times, manager owns any memory allocated inside. External code should never delete memory returned by it.
|
virtual |
Destructor.
| Material* nkAstraeus::MaterialManager::createOrRetrieve | ( | nkMemory::StringView | name, |
| MATERIAL_TYPE | type | ||
| ) |
Creates if unavailable, or retrieves if available, a material.
Depending on the parameter given for the type, the Material instance retrieved will be :
| Value | Pointer type |
|---|---|
| MATERIAL_TYPE::PBS | PbsMaterial |
To address it fully, casting is required. For instance :
| name | The name of the material to retrieve. |
| type | The material type to create. |
| Material* nkAstraeus::MaterialManager::record | ( | nkMemory::StringView | name, |
| nkMemory::UniquePtr< Material > | resource | ||
| ) |
Records an already existing resource in the manager, passing its ownership around.
| name | The name under which the resource should be recorded. |
| resource | The resource to record. |
| Material* nkAstraeus::MaterialManager::get | ( | nkMemory::StringView | name | ) |
Retrieves a material.
| name | The name of the material to retrieve. |
| Material* nkAstraeus::MaterialManager::getByIndex | ( | unsigned int | id | ) |
Get a material, by index. Note that one index can map to a different material after memory is changed. Useful to loop over all available materials in one go.
| id | The index of the material to retrieve. |
| void nkAstraeus::MaterialManager::rename | ( | nkMemory::StringView | currentName, |
| nkMemory::StringView | newName | ||
| ) |
Renames a material.
| currentName | The name of the material to rename. |
| newName | The name to reassign to the material. |
| void nkAstraeus::MaterialManager::erase | ( | nkMemory::StringView | name | ) |
Erases and frees a material.
| name | The name of the material to erase. |
| nkMemory::UniquePtr<Material> nkAstraeus::MaterialManager::relinquish | ( | nkMemory::StringView | name | ) |
Requests the manager to relinquish the ownership of a resource and pass it around.
| name | The name of the recorded resource to relinquish. |